Skip to main content
Version: 24.08

Search for the state of golden record tasks by task identifiers

Returns the state of golden record tasks based on the provided task identifiers. Unknown task identifiers are ignored.

Request Body required
  • taskIds string[] required
Responses

The state of the tasks for the provided task identifiers.


Schema
  • tasks object[]
  • taskId string
  • recordId string

    The identifier of the gate record for which this task has been created

  • businessPartnerResult object

    The business partner data to be processed

  • nameParts object[]
  • name string
  • type string

    Possible values: [LegalName, ShortName, LegalForm, SiteName, AddressName]

  • owningCompany string
  • uncategorized object
  • nameParts string[]
  • identifiers object[]
  • value string
  • type string
  • issuingBody string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • address object
  • bpnReference object
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • addressName string
  • identifiers object[]
  • value string
  • type string
  • issuingBody string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • physicalAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • administrativeAreaLevel2 string
  • administrativeAreaLevel3 string
  • postalCode string
  • city string
  • district string
  • street object
  • name string
  • houseNumber string
  • houseNumberSupplement string
  • milestone string
  • direction string
  • namePrefix string
  • additionalNamePrefix string
  • nameSuffix string
  • additionalNameSuffix string
  • companyPostalCode string
  • industrialZone string
  • building string
  • floor string
  • door string
  • taxJurisdictionCode string
  • alternativeAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • postalCode string
  • city string
  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

  • deliveryServiceQualifier string
  • deliveryServiceNumber string
  • hasChanged boolean
  • legalEntity object
  • bpnReference object
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • legalName string
  • legalShortName string
  • legalForm string
  • identifiers object[]
  • value string
  • type string
  • issuingBody string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • isCatenaXMemberData boolean
  • hasChanged boolean
  • legalAddress object
  • bpnReference object
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • addressName string
  • identifiers object[]
  • value string
  • type string
  • issuingBody string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • physicalAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • administrativeAreaLevel2 string
  • administrativeAreaLevel3 string
  • postalCode string
  • city string
  • district string
  • street object
  • name string
  • houseNumber string
  • houseNumberSupplement string
  • milestone string
  • direction string
  • namePrefix string
  • additionalNamePrefix string
  • nameSuffix string
  • additionalNameSuffix string
  • companyPostalCode string
  • industrialZone string
  • building string
  • floor string
  • door string
  • taxJurisdictionCode string
  • alternativeAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • postalCode string
  • city string
  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

  • deliveryServiceQualifier string
  • deliveryServiceNumber string
  • hasChanged boolean
  • site object
  • bpnReference object
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • siteName string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • hasChanged boolean
  • siteMainAddress object
  • bpnReference object
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • addressName string
  • identifiers object[]
  • value string
  • type string
  • issuingBody string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • physicalAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • administrativeAreaLevel2 string
  • administrativeAreaLevel3 string
  • postalCode string
  • city string
  • district string
  • street object
  • name string
  • houseNumber string
  • houseNumberSupplement string
  • milestone string
  • direction string
  • namePrefix string
  • additionalNamePrefix string
  • nameSuffix string
  • additionalNameSuffix string
  • companyPostalCode string
  • industrialZone string
  • building string
  • floor string
  • door string
  • taxJurisdictionCode string
  • alternativeAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • postalCode string
  • city string
  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

  • deliveryServiceQualifier string
  • deliveryServiceNumber string
  • hasChanged boolean
  • siteMainIsLegalAddress boolean
  • additionalAddress object
  • bpnReference object
  • referenceValue string
  • desiredBpn string
  • referenceType string

    Possible values: [Bpn, BpnRequestIdentifier]

  • addressName string
  • identifiers object[]
  • value string
  • type string
  • issuingBody string
  • states object[]
  • validFrom date-time
  • validTo date-time
  • type string

    Possible values: [ACTIVE, INACTIVE]

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfSharingMembers int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • physicalAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • administrativeAreaLevel2 string
  • administrativeAreaLevel3 string
  • postalCode string
  • city string
  • district string
  • street object
  • name string
  • houseNumber string
  • houseNumberSupplement string
  • milestone string
  • direction string
  • namePrefix string
  • additionalNamePrefix string
  • nameSuffix string
  • additionalNameSuffix string
  • companyPostalCode string
  • industrialZone string
  • building string
  • floor string
  • door string
  • taxJurisdictionCode string
  • alternativeAddress object
  • geographicCoordinates object
  • longitude float
  • latitude float
  • altitude float
  • country string
  • administrativeAreaLevel1 string
  • postalCode string
  • city string
  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

  • deliveryServiceQualifier string
  • deliveryServiceNumber string
  • hasChanged boolean
  • type string

    Possible values: [LegalEntity, Site, Address]

  • processingState object

    Contains detailed information about the current processing state of a golden record task

  • resultState string

    Possible values: [Pending, Success, Error]

    The processing result of the task, can also still be pending

  • step string

    Possible values: [CleanAndSync, PoolSync, Clean]

    The last step this task has entered

  • stepState string

    Possible values: [Queued, Reserved, Success, Error]

    Whether the task is queued or already reserved for the latest step

  • errors object[]

    The actual errors that happened during processing if the task has an error result state. The errors refer to the latest step.

  • type string

    Possible values: [Timeout, Unspecified]

    The type of error that occurred

  • description string

    The free text, detailed description of the error

  • createdAt date-time

    When the task has been created

  • modifiedAt date-time

    When the task has last been modified

  • timeout date-time deprecated

    The timestamp until the task is removed from the Orchestrator

Loading...